home *** CD-ROM | disk | FTP | other *** search
/ 1,000+ Great Games / 1_1000 Games.iso / ROTT / ROTTCOMP.ZIP / README.TXT next >
Encoding:
Text File  |  1995-11-30  |  2.3 KB  |  80 lines
  1.                   ROTTCMP 1.0
  2.             Copyright 1995 Martin H. Smith
  3.                   All Rights Reserved
  4.               Non profit redistribution permitted
  5.  
  6. What's It For
  7. -------------
  8.  
  9. ROTT level files shipped with the game are stored with a run length encoding
  10. compression scheme which, whilst simple, achieves rather good results on the
  11. data in question.
  12.  
  13. The ROTT editors around seem to save levels without using the compression and
  14. this makes them very large. A 20 level file probably occupies 2MB without
  15. compression and 400K with it.
  16.  
  17. And I'm short of disk space so I wrote this program to take level files and
  18. compress them. It will also uncompress files in case people ever write
  19. utilitities that can't handle the compression.
  20.  
  21. System Requirements
  22. -------------------
  23.  
  24. Minimal, if you can run ROTT you far exceed them.
  25.  
  26. Usage
  27. -----
  28.  
  29.     ROTTCMP [options] [files]
  30.  
  31. Options are described below, the input files should be .RTC, .RTL or .RTR
  32. files, wildcards are supported.
  33.  
  34.  
  35. Options
  36. -------
  37.  
  38.     -c    Compress input files
  39.     -d    Decompress input files (exclusive with -c)
  40.     -i    Print info on input files (default)
  41.  
  42.     -q    Quiet mode, report errors only
  43.     -v    Verbose mode, produce debug output (exclusive with -q)
  44.  
  45.     -x    Fill in the CRC fields in level headers
  46.  
  47.     ROTT editors seem to leave this set to 0 in levels, this may only be
  48.     significant for multiplayer levels but can be added if you specify
  49.     this option.
  50.  
  51.     -a    Don't copy any extra data after end of levels
  52.  
  53.     Programs such as RANDROTT add comments to the end of the file, which
  54.     will be displayed by this program. With -a it doesn't get copied as
  55.     I've found some files have a couple of K of zeroes tacked on the end.
  56.  
  57.     -j    Junk levels which fail sanity checks
  58.  
  59.     With this option any duff levels (e.g 0 length or odd data start pos)
  60.     are ignored in the compression and removed from the output. Without
  61.     this option an error occurs if the file contains any such errors and
  62.     compression is abandoned.
  63.  
  64. Example
  65. -------
  66.  
  67. Compress all game files in current directory
  68.  
  69. ROTTCMP -c *.RTL
  70.  
  71. Leaves old files renamed to .BAK if compression succeeds.
  72.  
  73. Authors Note
  74. ------------
  75.  
  76. This is the first version of the program and I hope I've accounted for all the
  77. weird things that can appear in the level files. If you find a level which
  78. can't be compressed (and it is actually playable) then please let me know at
  79. msmith@lssec.bt.co.uk
  80.